Skip to content

Conversation

@aram356
Copy link
Collaborator

@aram356 aram356 commented Jan 3, 2026

Summary

This PR consolidates and modernizes the Trusted Server documentation, improving organization, adding new content, and setting up proper formatting tooling.

Changes

Documentation Restructuring

  • Simplified README.md - Condensed from 250+ lines to ~50 lines, now pointing to the full documentation site
  • Consolidated configuration docs - Merged configuration-reference.md and environment-variables.md into an expanded configuration.md
  • Moved onboarding content - Relocated docs/ONBOARDING.md to docs/guide/onboarding.md with updates
  • Expanded APS integration - Moved docs/guide/aps.md content into docs/guide/integrations/aps.md

New Documentation

  • docs/roadmap.md - Project roadmap
  • docs/business-use-cases.md - Business value documentation
  • docs/guide/fastly.md - Fastly-specific deployment guide
  • docs/guide/proxy-signing.md - Proxy signing documentation
  • .env.example - Example environment configuration

Formatting & Tooling

  • Added Prettier config (.prettierrc, .prettierignore) to docs
  • Added ESLint config (eslint.config.js, tsconfig.json) to docs
  • Added format-docs job to CI workflow
  • Updated VitePress config to dynamically read tool versions from .tool-versions

Deleted Files (consolidated elsewhere)

  • docs/ONBOARDING.mddocs/guide/onboarding.md
  • docs/guide/configuration-reference.md → merged into configuration.md
  • docs/guide/environment-variables.md → merged into configuration.md
  • docs/guide/aps.md → merged into integrations/aps.md

Minor Updates

  • Standardized YAML/JSON quote style in GitHub workflows
  • Updated various integration docs (Didomi, Lockr, Prebid, etc.)
  • Improved navigation structure in VitePress sidebar

Stats

  • 53 files changed
  • +4,827 insertions / -4,386 deletions

Test Plan

  • Verify docs build successfully with npm run build in docs/
  • Verify formatting passes with npm run format and npm run lint
  • Check all internal links resolve correctly
  • Review navigation sidebar structure in local previ

Copy link
Collaborator

@jevansnyc jevansnyc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@aram356 aram356 merged commit ce1e9ea into main Jan 31, 2026
5 checks passed
@aram356 aram356 deleted the feature/update-docs branch January 31, 2026 06:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants